pp108 : Standard Views Composite Control Properties Interface

Standard Views Composite Control Properties Interface

This topic describes the various fields on Properties pane of a Standard View Composite Control.

The Business Measure Composite Control Properties Interface helps in configuring properties of composite control.

Table 1. Fields on Properties Interface of ActivityCycleTime_SpecificActivity Composite Control

Field Name

Description

Title

Activity Cycle Time appears by default.

Period In

Select one of the following: Second(s), Minute(s), Hour(s), Day(s), Week(s), Month(s), Year(s).

Group By

Select one of the following: Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart. Pie Chart appears by default.

X-Axis Caption

Period is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Rotate: To display the Rotated label. Displays the labels vertically.
  • Slant: To display the label in Slant. Displays the labels at 45 degrees angle.
  • Stagger: To display the Stagger label. Displays the labels in multiple lines.
  • Wrap: To display the Wrapped label. If enough space is not available on the chart, the text of the labels will be trimmed and an ellipses (...) is added at the end and would show tool-tips for those labels.
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

Cycle Time is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click , and select the business process.

Activity Name

Click , and select the activity.


Table 2. Fields on Properties Interface of ActivityCycleTimePerUser_SpecificActivity Composite Control

Field Name

Description

Title

Cycle Time for Activity per User appears by default.

Period In

Select one of the following: Second(s), Minute(s), Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header check box

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart . Pie Chart appears by default.

X-Axis Caption

User is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

Cycle Time is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.

Activity Name

Click and select the activity.


Table 3. Fields on Properties Interface of ActivityInstancesPerStatus_SpecificActivity Composite Control

Field Name

Description

Title

No. of Activity Instances per Status appears by default.

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart. Pie Chart appears by default.

X-Axis Caption

Status is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No Of Instances is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.

Activity Name

Click and select the activity for which you want to display activity instances per status.


Table 4. Fields on Properties Interface of ActivityTasksPerUserPerStatus_SpecificActivity Composite Control

Field Name

Description

Title

No. of Tasks per User by Status appears by default.

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Column 2D, Line 2D, Bar 2D.

X-Axis Caption

User is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No. Of Tasks is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.

Activity Name

Click and select the activity for which you want to display activity instances per status.


Table 5. Fields on Properties Interface of CompletedVsScheduledTasksAcrossProcess_User Composite Control

Field Name

Description

Title

Completed Vs Scheduled Tasks for User across Processes appears by default.

Group By

Select one of the following: Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Column 2D, Line 2D, Bar 2D.

X-Axis Caption

Period is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No. Of Tasks is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

User

Click and select the user.


Table 6. Fields on Properties Interface of CompletedVsScheduledTasksForActivity_User Composite Control

Field Name

Description

Title

Completed Vs Scheduled Tasks for User for Activity appears by default.

Group By

Select one of the following: Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Column 2D, Line 2D, Bar 2D.

X-Axis Caption

Period is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No. Of Tasks is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour, Day, Week, Month, Year.

Process Name

Click and select the business process.

Activity Name

Click and select the activity.

User

Click and select the user.


Table 7. Fields on Properties Interface of ProcessActivitiesCycleTime_SpecificProcess Composite Control

Field Name

Description

Title

Cycle time per Activity appears by default.

Period In

Select one of the following: Second(s), Minute(s), Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart. Pie Chart appears by default.

X-Axis Caption

Activity Name is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

Cycle Time is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.


Table 8. Fields on Properties Interface of ProcessActivitiesInstancesPerStatus_SpecificProcess Composite Control

Field Name

Description

Title

No. of Instances per Activity by Status appears by default.

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Column 2D, Line 2D, Bar 2D.

X-Axis Caption

Activity Name is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No Of Instances is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.


Table 9. Fields on Properties Interface of ProcessCycleTime_SpecificProcess Composite Control

Field Name

Description

Title

Process Cycle Time appears by default.

Period In

Select one of the following: Second(s), Minute(s), Hour(s), Day(s), Week(s), Month(s), Year(s).

Group By

Select one of the following: Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart.

X-Axis Caption

Period is displayed by default. Specify x-axis caption. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

Cycle Time is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.


Table 10. Fields on Properties Interface of ProcessInstancesPerStatus_AcrossProcess Composite Control

Field Name

Description

Title

Aggregate Process Instances per Status appears by default.

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart.

X-Axis Caption

Status is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No Of Instances is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).


Table 11. Fields on Properties Interface of ProcessInstancesPerStatus_SpecificProcess Composite Control

Field Name

Description

Title

Process Instances per Status appears by default.

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart.

X-Axis Caption

Status is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No Of Instances is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.


Table 12. Fields on Properties Interface of ProcessLoadForPeriod_AcrossProcess Composite Control

Field Name

Description

Title

Process Load for Period appears by default.

Group By

Select one of the following: Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart. Pie Chart appears by default.

X-Axis Caption

Period is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

Cycle Time is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).


Table 13. Fields on Properties Interface of ProcessLoadforPeriod_SpecificProcess Composite Control

Field Name

Description

Title

Process Load for Period appears by default.

Group By

Select one of the following: Hour(s), Day(s), Week(s), Month(s), Year(s).

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart. Pie Chart appears by default.

X-Axis Caption

Period is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No. of Instances is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.


Table 14. Fields on Properties Interface of TopXInstancesByLeadTimeForStatus_SpecificProcess Composite Control

Field Name

Description

Title

GetTopXInstancesByLeadTimeForStatus appears by default.

No Of Instances

Enter the number of instances.

Period In

Select one of the following: Second(s), Minute(s), Hour(s), Day(s), Week(s), Month(s), Year(s).

Status

Select the status of the business process for which the Top X Instances by Lead time for Status are displayed, from one of the following: Aborted, Completed, Suspended, Terminated, Waiting.

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart.

X-Axis Caption

Instance ID is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

Lead Time is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).

Process Name

Click and select the business process.


Table 15. Fields on Properties Interface of TopXInstancesPerStatus_AcrossProcess Composite Control

Field Name

Description

Title

GetTopXProcessesByStatus appears by default.

No Of Processes

Enter the number of processes for which you want to display Top X Instances per status across process.

Status

Select the status of the business process for which the Top X Instances by Lead time for Status are displayed, from one of the following: Aborted, Completed, Suspended, Terminated, Waiting.

Show Header

Select the check box to give inputs at run-time.

Chart Type

Specify one of the following view type: Line Chart, Bar Chart, Pyramid, Pie Chart.

X-Axis Caption

Process Name is displayed by default. You can edit them if required.
Note: The X-Axis Caption is not available for Pyramid and Pie charts.

X-Axis Caption Style

Select one of the following:

  • Truncate: To display the truncated label
  • Slant: To display the label in Slant
  • Stagger: To display the Stagger label
  • Rotate: To display the Rotated label
  • Wrap: To display the Wrapped label
    Note:
  1. The X-Axis Caption Style is not available for Pyramid and Pie charts.
  2. If the x-axis field value is lengthy, you are recommended to select Truncate or Wrap to get a proper graph without any distortion.

Y-Axis Caption

No of Instances is displayed by default. You can edit them if required.
Note: The Y-Axis Caption is not available for Pyramid and Pie charts.

Render View on load check box

Select if you want to render the view while the page loads. The check box is selected by default.

Time Frame group box

Enter time period in Last text box and select one of the following unit of time: Hour(s), Day(s), Week(s), Month(s), Year(s).


Table 16. APIs for the Standard Views Composite Control

API Name

Description

setAsynchronous(String)

Value can be "true" or "false". By default, the request is sent in asynchronous mode. To change the mode to synchronous, invoke the API with value "false" and invoke refresh API to redraw the chart.

refresh

Use the API to redraw the chart.

getChartObject

This API returns the Chart object ,on which the APIs of Chart can be invoked


Table 17. Events for the Standard Views Composite Control

Event

Description

ondataclick

Fires when clicked on a data point on the chart. Refer to the following sample code.

function Form_InitDone(eventObject)
{
     <svid>.addListener(ondataclicklistenerFn);
}
function ondataclicklistenerFn(eventObject)
{
//eventObject.businessObject will give the businessobject as a JSON object for the clicked datapoint
}